home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Collection of Tools & Utilities
/
Collection of Tools and Utilities.iso
/
edit
/
la002.zip
/
CBX266.EXE
/
SGMAN.DOC
< prev
next >
Wrap
Text File
|
1989-02-24
|
2KB
|
64 lines
VERSION LOG
SPYGLASS DOCUMENT GENERATOR
version remarks
----------------------------------------------------------------
1.1 Bug fix to recognize key files.
1.0 First version.
To generate Captain Blackbeard output use the command:
SGMAN CB.MAN >CB.DOC
The Spyglass Document Generator (SGMAN) generates a
context-sensitive manual. We created it to satisfy the original
design goals of the Blackbeard product. These goals include:
o An excellent text editing system.
o An easy to use, does what you expect paradigm.
o No external documentation required.
We created the bb.doc file after many requests for a
Blackbeard user manual. This met some needs, but we still
wanted to achieve our third design goal -- no documentation.
With the Spyglass Document Generator, we have done it. This
documentation method is superior to printed material because it
is:
o always up to date;
o distributed on the same medium as the program;
o tailored to each user.
The Spyglass Document Generator generates the Captain Blackbeard
manual. This means that if you have redefined any keys to other
functions, the manual will contain the proper reference to your
key. This later feature is a first in the industry (as far as I
know). Not only will your manual be up to date (straight from
the help file), but it will be customized for your use of the
product.
Running SGMAN
To run SGMAN, enter the following
SGMAN textFile >filename
where textFile is the name of a document directive filename, and
filename is the name of the output document file (e.g., CB.DOC).
Document Directive File
CB.MAN is distributed as a good start for a document directive
file for Captain Blackbeard. When you look at CB.MAN you will
see two types of lines. The first type is a period (.) followed
by some text. SGMAN will copy this line not counting the
first . directly to the output. This type of line can be used
to include any comments of formatting features you may desire.
The second type of line is a number, or string. This number
represents a help number. The text represents a help message
title. Each help message in Blackbeard has a number and title.
SGMAN looks up the help message corresponding to the number or
title and writes it to the output.